2.4.1 通用错误码

以下是服务端常用错误码列表,部分未列入的错误码可以在具体 API 接口文档中查询到。您也可以通过左上角搜索功能,全局查找错误码、说明和排查建议。

1、AlreadyExist

排查建议:该错误一般是由于创建的对象在零信任设备中已存在,请确认对象是否已存在。

错误码 说明
AlreadyExist
├─ AlreadyExist.User 用户已存在
├─ AlreadyExist.Group 组织架构已存在
├─ AlreadyExist.Role 角色已存在
├─ AlreadyExist.Resource 应用已存在
├─ AlreadyExist.ResourceGroup 应用分类已存在
├─ AlreadyExist.UserDirectory 用户目录已存在
├─ AlreadyExist.Name 名称已存在
├─ AlreadyExist.ExternalId 外部id已存在
├─ AlreadyExist.AuthPolicy 认证策略已存在
├─ AlreadyExist.UserPolicy 用户策略已存在

2、NotExist

排查建议:该错误一般是由于操作的对象在零信任设备中不存在,请确认对象是否存在。

错误码 说明
NotExist
├─ NotExist.User 用户不存在
├─ NotExist.Group 组织架构不存在
├─ NotExist.Role 角色不存在
├─ NotExist.Resource 应用不存在
├─ NotExist.ResourceAssign 应用不存在
├─ NotExist.ResourceGroup 应用分类不存在
├─ NotExist.ResourceGroupAssign 应用分类不存在
├─ NotExist.UserDirectory 用户目录不存在
├─ NotExist.AuthPolicy 认证策略不存在
├─ NotExist.UserPolicy 用户策略不存在

3、NotAllowed

排查建议:该错误一般是由于执行了零信任设备不允许的操作(如编辑用户名,这是不允许的),请确认操作是否正确。

错误码 说明
NotAllowed
├─ NotAllowed.EditExternalRole 不允许编辑此外部角色
├─ NotAllowed.EditUserDirectory 不允许编辑此用户目录
├─ NotAllowed.EditName 不允许编辑名称
├─ NotAllowed.EditAuthServer 不允许编辑认证服务器
├─ NotAllowed.DeleteRootGroup 不允许删除根组织架构
├─ NotAllowed.EditRootGroupExternalId 不允许修改根组织架构的外部id
├─ NotAllowed.EditExternalId 不允许修改外部id
├─ NotAllowed.EditGroup 不允许修改组织架构
├─ NotAllowed.FeatureNotEnabled 由于特性未开启,不允许执行此操作

4、NotSupported

排查建议:该错误一般是由于执行了零信任设备不支持的操作(如访问了一个不存在的接口),请确认所调用的接口、或对象是否存在。

错误码 说明
NotSupported
├─ NotSupported.Method 请求方法不支持,当前仅支持 GET、POST
├─ NotSupported.Url 请求的接口不存在

5、NotPermitted

排查建议:该错误一般是由于执行了调用方无权限的操作(如删除一个无权限删除的目标),请确认调用方是否有相应权限。

错误码 说明
NotPermitted 执行了调用方无权限的操作

6、InvalidParam

排查建议:该错误一般是由于请求参数(请求body或query)未通过校验(如参数中含有不合法的值),请确认请求参数是否正确。建议结合响应体 msg 定位不合法的参数及原因。

错误码 说明
InvalidParam 参数未通过校验,如参数中含有不合法的值

7、DecryptFailed

排查建议:该错误一般是由于创建用户时,用户的密码使用了RSA算法进行加密,零信任设备对密码字段解密失败。请检查用户的密码字段的加密算法是否计算正确(或加密的公钥是否正确)。

错误码 说明
DecryptFailed 解密失败,如用户名密码的密文解密失败

8、AuthFailed

排查建议:该错误一般是由于调用方在发起请求时,请求头部填写不正确(如:签名计算错误、字段错误、缺少必要字段等),请检查请求头部是否按 请求头部 的要求传递。

错误码 说明
AuthFailed 认证失败,如 openAPI 鉴权失败

9、InternalError

排查建议:建议重试,并结合响应体 msg 定位失败原因。

错误码 说明
InternalError 内部错误,如数据库异常

10、TooManyRequest

排查建议:该错误一般是由于调用方请求速度过快,触发了请求数量限制,请稍后重试。

错误码 说明
TooManyRequest 触发了请求连接数限制
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-11-20 11:03

results matching ""

    No results matching ""